<!DOCTYPE html>
<html lang="en-US">
<head>
    <meta charset="UTF-8"/>
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="language" content="en" />
        <link href="./assets/ffd55088/css/bootstrap.css" rel="stylesheet">
<link href="./assets/5cf9384a/solarized_light.css" rel="stylesheet">
<link href="./assets/6c54116e/style.css" rel="stylesheet">
<script src="./assets/a44cef0f/jquery.js"></script>
<script src="./assets/ffd55088/js/bootstrap.js"></script>
<script src="./assets/8ac4e28a/jssearch.js"></script>    <title>FixtureController, yii\faker\FixtureController - Yii Framework 2.0 API Documentation</title>
</head>
<body>

<div class="wrap">
    <nav id="w11357" class="navbar-inverse navbar-fixed-top navbar" role="navigation"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#w11357-collapse"><span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span></button><a class="navbar-brand" href="./index.html">Yii Framework 2.0 API Documentation</a></div><div id="w11357-collapse" class="collapse navbar-collapse"><ul id="w11358" class="navbar-nav nav"><li><a href="./index.html">Class reference</a></li>
<li class="dropdown"><a class="dropdown-toggle" href="#" data-toggle="dropdown">Extensions <b class="caret"></b></a><ul id="w11359" class="dropdown-menu"><li><a href="./ext-apidoc-index.html" tabindex="-1">apidoc</a></li>
<li><a href="./ext-authclient-index.html" tabindex="-1">authclient</a></li>
<li><a href="./ext-bootstrap-index.html" tabindex="-1">bootstrap</a></li>
<li><a href="./ext-codeception-index.html" tabindex="-1">codeception</a></li>
<li><a href="./ext-debug-index.html" tabindex="-1">debug</a></li>
<li><a href="./ext-elasticsearch-index.html" tabindex="-1">elasticsearch</a></li>
<li><a href="./ext-faker-index.html" tabindex="-1">faker</a></li>
<li><a href="./ext-gii-index.html" tabindex="-1">gii</a></li>
<li><a href="./ext-imagine-index.html" tabindex="-1">imagine</a></li>
<li><a href="./ext-jui-index.html" tabindex="-1">jui</a></li>
<li><a href="./ext-mongodb-index.html" tabindex="-1">mongodb</a></li>
<li><a href="./ext-redis-index.html" tabindex="-1">redis</a></li>
<li><a href="./ext-smarty-index.html" tabindex="-1">smarty</a></li>
<li><a href="./ext-sphinx-index.html" tabindex="-1">sphinx</a></li>
<li><a href="./ext-swiftmailer-index.html" tabindex="-1">swiftmailer</a></li>
<li><a href="./ext-twig-index.html" tabindex="-1">twig</a></li></ul></li>
<li><a href="./guide-README.html">Guide</a></li></ul><div class="navbar-form navbar-left" role="search">
  <div class="form-group">
    <input id="searchbox" type="text" class="form-control" placeholder="Search">
  </div>
</div>
</div></nav>
    <div id="search-resultbox" style="display: none;" class="modal-content">
        <ul id="search-results">
        </ul>
    </div>

    
<div class="row">
    <div class="col-md-3">
                <div id="navigation" class="list-group"><a class="list-group-item active" href="#navigation-11356" data-toggle="collapse" data-parent="#navigation">yii\faker <b class="caret"></b></a><div id="navigation-11356" class="submenu panel-collapse collapse in"><a class="list-group-item active" href="./yii-faker-fixturecontroller.html">FixtureController</a></div></div>    </div>
    <div class="col-md-9 api-content" role="main">
        <h1>Class yii\faker\FixtureController</h1>
<div class="top-nav">
    <a href="index.html">All Classes</a>
            | <a href="#properties">Properties</a>
                | <a href="#methods">Methods</a>
                | <a href="#events">Events</a>
                | <a href="#constants">Constants</a>
    </div>

<table class="summaryTable docClass table table-bordered">
    <colgroup>
        <col class="col-name" />
        <col class="col-value" />
    </colgroup>
            <tr><th>Inheritance</th><td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a> &raquo;
<a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a> &raquo;
<a href="yii-console-controller.html">yii\console\Controller</a> &raquo;
<a href="yii-base-controller.html">yii\base\Controller</a> &raquo;
<a href="yii-base-component.html">yii\base\Component</a> &raquo;
<a href="yii-base-object.html">yii\base\Object</a></td></tr>
                <tr><th>Implements</th><td><a href="yii-base-configurable.html">yii\base\Configurable</a>, <a href="yii-base-viewcontextinterface.html">yii\base\ViewContextInterface</a></td></tr>
                    <tr><th>Uses Traits</th><td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td></tr>
                            <tr><th>Available since version</th><td>2.0.0</td></tr>
                    <tr>
          <th>Source Code</th>
          <td><a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php">https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php</a></td>
        </tr>
    </table>

<div class="class-description">
    <p><strong>This command creates fixtures based on a given template.</strong></p>
    <p>Fixtures are one of the important paths in unit testing. To speed up developers
work these fixtures can be generated automatically, based on prepared template.
This command is a simple wrapper for the <a href="https://github.com/fzaninotto/Faker">Faker</a> library.</p>
<p>You should configure your application as follows (you can use any alias, not only "fixture"):</p>
<pre><code class="hljs php"><span class="hljs-string">'controllerMap'</span> =&gt; [
    <span class="hljs-string">'fixture'</span> =&gt; [
        <span class="hljs-string">'class'</span> =&gt; <span class="hljs-string">'yii\faker\FixtureController'</span>,
    ],
],
</code></pre>
<p>To start using the command you need to be familiar (read guide) with the Faker library and
generate fixtures template files, according to the given format:</p>
<pre><code class="hljs php language-php"><span class="hljs-comment">// users.php file under template path (by default @tests/unit/templates/fixtures)</span>
<span class="hljs-keyword">return</span> [
    <span class="hljs-string">'name'</span> =&gt; <span class="hljs-variable">$faker</span>-&gt;firstName,
    <span class="hljs-string">'phone'</span> =&gt; <span class="hljs-variable">$faker</span>-&gt;phoneNumber,
    <span class="hljs-string">'city'</span> =&gt; <span class="hljs-variable">$faker</span>-&gt;city,
    <span class="hljs-string">'password'</span> =&gt; Yii::<span class="hljs-variable">$app</span>-&gt;getSecurity()-&gt;generatePasswordHash(<span class="hljs-string">'password_'</span> . <span class="hljs-variable">$index</span>),
    <span class="hljs-string">'auth_key'</span> =&gt; Yii::<span class="hljs-variable">$app</span>-&gt;getSecurity()-&gt;generateRandomString(),
    <span class="hljs-string">'intro'</span> =&gt; <span class="hljs-variable">$faker</span>-&gt;sentence(<span class="hljs-number">7</span>, <span class="hljs-keyword">true</span>),  <span class="hljs-comment">// generate a sentence with 7 words</span>
];
</code></pre>
<p>If you use callback as an attribute value it will be called with the following three parameters:</p>
<ul>
<li><code>$faker</code>: the Faker generator instance</li>
<li><code>$index</code>: the current fixture index. For example if user need to generate 3 fixtures for user table, it will be 0..2.</li>
</ul>
<p>After you set all needed fields in callback, you need to return $fixture array back from the callback.</p>
<p>After you prepared needed templates for tables you can simply generate your fixtures via command</p>
<pre><code class="hljs dockerfile">yii fixture/generate <span class="hljs-built_ins">user</span>

//generate fixtures <span class="hljs-built_ins">from</span> several templates, for example:
yii fixture/generate <span class="hljs-built_ins">user</span> profile team
</code></pre>
<p>In the code above "users" is template name, after this command run, new file named same as template
will be created under the <code>$fixtureDataPath</code> folder.
You can generate fixtures for all templates, for example:</p>
<pre><code class="hljs apache"><span class="hljs-keyword">yii</span> fixture/generate-<span class="hljs-literal">all</span>
</code></pre>
<p>This command will generate fixtures for all template files that are stored under $templatePath and
store fixtures under <code>$fixtureDataPath</code> with file names same as templates names.</p>
<p>You can specify how many fixtures per file you need by the second parameter. In the code below we generate
all fixtures and in each file there will be 3 rows (fixtures).</p>
<pre><code class="hljs apache"><span class="hljs-keyword">yii</span> fixture/generate-<span class="hljs-literal">all</span> --count=3
</code></pre>
<p>You can specify different options of this command:</p>
<pre><code class="hljs javascript"><span class="hljs-comment">//generate fixtures in russian language</span>
yii fixture/generate user --count=<span class="hljs-number">5</span> --language=ru_RU

<span class="hljs-comment">//read templates from the other path</span>
yii fixture/generate-all --templatePath=@app/path/to/my/custom/templates

<span class="hljs-comment">//generate fixtures into other folders</span>
yii fixture/generate-all --fixtureDataPath=@tests/unit/fixtures/subfolder1/subfolder2/subfolder3
</code></pre>
<p>You can see all available templates by running command:</p>
<pre><code class="hljs php"><span class="hljs-comment">//list all templates under default template path (i.e. '@tests/unit/templates/fixtures')</span>
yii fixture/templates

<span class="hljs-comment">//list all templates under specified template path</span>
yii fixture/templates --templatePath=<span class="hljs-string">'@app/path/to/my/custom/templates'</span>
</code></pre>
<p>You also can create your own data providers for custom tables fields, see Faker library guide for more info (<a href="https://github.com/fzaninotto/Faker">https://github.com/fzaninotto/Faker</a>);
After you created custom provider, for example:</p>
<pre><code class="hljs php"><span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">Book</span> <span class="hljs-keyword">extends</span> \<span class="hljs-title">Faker</span>\<span class="hljs-title">Provider</span>\<span class="hljs-title">Base</span>
</span>{

    <span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">title</span><span class="hljs-params">(<span class="hljs-variable">$nbWords</span> = <span class="hljs-number">5</span>)</span>
    </span>{
        <span class="hljs-variable">$sentence</span> = <span class="hljs-variable">$this</span>-&gt;generator-&gt;sentence(<span class="hljs-variable">$nbWords</span>);
        <span class="hljs-keyword">return</span> mb_substr(<span class="hljs-variable">$sentence</span>, <span class="hljs-number">0</span>, mb_strlen(<span class="hljs-variable">$sentence</span>) - <span class="hljs-number">1</span>);
    }

}
</code></pre>
<p>you can use it by adding it to the $providers property of the current command. In your console.php config:</p>
<pre><code class="hljs php">   <span class="hljs-string">'controllerMap'</span> =&gt; [
       <span class="hljs-string">'fixture'</span> =&gt; [
           <span class="hljs-string">'class'</span> =&gt; <span class="hljs-string">'yii\faker\FixtureController'</span>,
           <span class="hljs-string">'providers'</span> =&gt; [
               <span class="hljs-string">'app\tests\unit\faker\providers\Book'</span>,
           ],
       ],
   ],
</code></pre>

    </div>

<a id="properties"></a>

<div class="summary doc-property">
<h2>Public Properties</h2>

<p><a href="#" class="toggle">Hide inherited properties</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-property" />
    <col class="col-type" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Property</th><th>Type</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="$action">
        <td><a href="yii-base-controller.html#$action-detail">$action</a></td>
        <td><a href="yii-base-action.html">yii\base\Action</a></td>
        <td>The action that is currently being executed.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$behaviors">
        <td><a href="yii-base-component.html#$behaviors-detail">$behaviors</a></td>
        <td><a href="yii-base-behavior.html">yii\base\Behavior</a>[]</td>
        <td>List of behaviors attached to this component</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="$color">
        <td><a href="yii-console-controller.html#$color-detail">$color</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether to enable ANSI color in the output.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr id="$count">
        <td><a href="yii-faker-fixturecontroller.html#$count-detail">$count</a></td>
        <td><a href="http://www.php.net/language.types.integer">integer</a></td>
        <td>Total count of data per fixture.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$defaultAction">
        <td><a href="yii-console-controllers-fixturecontroller.html#$defaultAction-detail">$defaultAction</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Controller default action ID.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr id="$fixtureDataPath">
        <td><a href="yii-faker-fixturecontroller.html#$fixtureDataPath-detail">$fixtureDataPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Alias to the fixture data path, where data files should be written.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$fixtures">
        <td><a href="yii-test-fixturetrait.html#$fixtures-detail">$fixtures</a></td>
        <td><a href="yii-test-fixture.html">yii\test\Fixture</a>[]</td>
        <td>The loaded fixtures for the current test case</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr id="$generator">
        <td><a href="yii-faker-fixturecontroller.html#$generator-detail">$generator</a></td>
        <td>\Faker\Generator</td>
        <td></td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$globalFixtures">
        <td><a href="yii-console-controllers-fixturecontroller.html#$globalFixtures-detail">$globalFixtures</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Global fixtures that should be applied when loading and unloading.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$help">
        <td><a href="yii-console-controller.html#$help-detail">$help</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td></td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="$helpSummary">
        <td><a href="yii-console-controller.html#$helpSummary-detail">$helpSummary</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td></td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="$id">
        <td><a href="yii-base-controller.html#$id-detail">$id</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The ID of this controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$interactive">
        <td><a href="yii-console-controller.html#$interactive-detail">$interactive</a></td>
        <td><a href="http://www.php.net/language.types.boolean">boolean</a></td>
        <td>Whether to run the command interactively.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr id="$language">
        <td><a href="yii-faker-fixturecontroller.html#$language-detail">$language</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Language to use when generating fixtures data.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$layout">
        <td><a href="yii-base-controller.html#$layout-detail">$layout</a></td>
        <td><a href="http://www.php.net/language.types.null">null</a>|<a href="http://www.php.net/language.types.string">string</a>|<a href="http://www.php.net/language.types.boolean">false</a></td>
        <td>The name of the layout to be applied to this controller's views.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$module">
        <td><a href="yii-base-controller.html#$module-detail">$module</a></td>
        <td><a href="yii-base-module.html">yii\base\Module</a></td>
        <td>The module that this controller belongs to.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$modules">
        <td><a href="yii-base-controller.html#$modules-detail">$modules</a></td>
        <td><a href="yii-base-module.html">yii\base\Module</a>[]</td>
        <td>All ancestor modules that this controller is located within.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$namespace">
        <td><a href="yii-console-controllers-fixturecontroller.html#$namespace-detail">$namespace</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Default namespace to search fixtures in</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$passedOptionValues">
        <td><a href="yii-console-controller.html#$passedOptionValues-detail">$passedOptionValues</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The properties corresponding to the passed options</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="$passedOptions">
        <td><a href="yii-console-controller.html#$passedOptions-detail">$passedOptions</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>The names of the options passed during execution</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr id="$providers">
        <td><a href="yii-faker-fixturecontroller.html#$providers-detail">$providers</a></td>
        <td><a href="http://www.php.net/language.types.array">array</a></td>
        <td>Additional data providers that can be created by user and will be added to the Faker generator.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$route">
        <td><a href="yii-base-controller.html#$route-detail">$route</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The route (module ID, controller ID and action ID) of the current request.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr id="$templatePath">
        <td><a href="yii-faker-fixturecontroller.html#$templatePath-detail">$templatePath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>Alias to the template path, where all tables templates are stored.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="$uniqueId">
        <td><a href="yii-base-controller.html#$uniqueId-detail">$uniqueId</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The controller ID that is prefixed with the module ID (if any).</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$view">
        <td><a href="yii-base-controller.html#$view-detail">$view</a></td>
        <td><a href="yii-base-view.html">yii\base\View</a>|<a href="yii-web-view.html">yii\web\View</a></td>
        <td>The view object that can be used to render views or view files.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="$viewPath">
        <td><a href="yii-base-controller.html#$viewPath-detail">$viewPath</a></td>
        <td><a href="http://www.php.net/language.types.string">string</a></td>
        <td>The directory containing the view files for this controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
    </table>
</div>

<a id="methods"></a>

<div class="summary doc-method">
<h2>Public Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
        <tr class="inherited" id="__call()">
        <td><a href="yii-base-object.html#__call()-detail">__call()</a></td>
        <td>Calls the named method which is not a class method.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__clone()">
        <td><a href="yii-base-component.html#__clone()-detail">__clone()</a></td>
        <td>This method is called after the object is created by cloning an existing one.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="__construct()">
        <td><a href="yii-base-controller.html#__construct()-detail">__construct()</a></td>
        <td></td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="__get()">
        <td><a href="yii-base-object.html#__get()-detail">__get()</a></td>
        <td>Returns the value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__isset()">
        <td><a href="yii-base-object.html#__isset()-detail">__isset()</a></td>
        <td>Checks if a property is set, i.e. defined and not null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__set()">
        <td><a href="yii-base-object.html#__set()-detail">__set()</a></td>
        <td>Sets value of an object property.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="__unset()">
        <td><a href="yii-base-object.html#__unset()-detail">__unset()</a></td>
        <td>Sets an object property to null.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="actionGenerate()">
        <td><a href="yii-faker-fixturecontroller.html#actionGenerate()-detail">actionGenerate()</a></td>
        <td>Generates fixtures and fill them with Faker data.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr id="actionGenerateAll()">
        <td><a href="yii-faker-fixturecontroller.html#actionGenerateAll()-detail">actionGenerateAll()</a></td>
        <td>Generates all fixtures template path that can be found.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="actionLoad()">
        <td><a href="yii-console-controllers-fixturecontroller.html#actionLoad()-detail">actionLoad()</a></td>
        <td>Loads the specified fixture data.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr id="actionTemplates()">
        <td><a href="yii-faker-fixturecontroller.html#actionTemplates()-detail">actionTemplates()</a></td>
        <td>Lists all available fixtures template files.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="actionUnload()">
        <td><a href="yii-console-controllers-fixturecontroller.html#actionUnload()-detail">actionUnload()</a></td>
        <td>Unloads the specified fixtures.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="actions()">
        <td><a href="yii-base-controller.html#actions()-detail">actions()</a></td>
        <td>Declares external actions for the controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr id="addProviders()">
        <td><a href="yii-faker-fixturecontroller.html#addProviders()-detail">addProviders()</a></td>
        <td>Adds users providers to the faker generator.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="afterAction()">
        <td><a href="yii-base-controller.html#afterAction()-detail">afterAction()</a></td>
        <td>This method is invoked right after an action is executed.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="ansiFormat()">
        <td><a href="yii-console-controller.html#ansiFormat()-detail">ansiFormat()</a></td>
        <td>Formats a string with ANSI codes</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="attachBehavior()">
        <td><a href="yii-base-component.html#attachBehavior()-detail">attachBehavior()</a></td>
        <td>Attaches a behavior to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="attachBehaviors()">
        <td><a href="yii-base-component.html#attachBehaviors()-detail">attachBehaviors()</a></td>
        <td>Attaches a list of behaviors to the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="beforeAction()">
        <td><a href="yii-faker-fixturecontroller.html#beforeAction()-detail">beforeAction()</a></td>
        <td>This method is invoked right before an action is executed.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="behaviors()">
        <td><a href="yii-base-component.html#behaviors()-detail">behaviors()</a></td>
        <td>Returns a list of behaviors that this component should behave as.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="bindActionParams()">
        <td><a href="yii-console-controller.html#bindActionParams()-detail">bindActionParams()</a></td>
        <td>Binds the parameters to the action.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="canGetProperty()">
        <td><a href="yii-base-object.html#canGetProperty()-detail">canGetProperty()</a></td>
        <td>Returns a value indicating whether a property can be read.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="canSetProperty()">
        <td><a href="yii-base-object.html#canSetProperty()-detail">canSetProperty()</a></td>
        <td>Returns a value indicating whether a property can be set.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr id="checkPaths()">
        <td><a href="yii-faker-fixturecontroller.html#checkPaths()-detail">checkPaths()</a></td>
        <td>Check if the template path and migrations path exists and writable.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="className()">
        <td><a href="yii-base-object.html#className()-detail">className()</a></td>
        <td>Returns the fully qualified name of this class.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="confirm()">
        <td><a href="yii-console-controller.html#confirm()-detail">confirm()</a></td>
        <td>Asks user to confirm by typing y or n.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr id="confirmGeneration()">
        <td><a href="yii-faker-fixturecontroller.html#confirmGeneration()-detail">confirmGeneration()</a></td>
        <td>Prompts user with message if he confirm generation with given fixture templates files.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="createAction()">
        <td><a href="yii-base-controller.html#createAction()-detail">createAction()</a></td>
        <td>Creates an action based on the given action ID.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
                <tr class="inherited" id="detachBehavior()">
        <td><a href="yii-base-component.html#detachBehavior()-detail">detachBehavior()</a></td>
        <td>Detaches a behavior from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="detachBehaviors()">
        <td><a href="yii-base-component.html#detachBehaviors()-detail">detachBehaviors()</a></td>
        <td>Detaches all behaviors from the component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="ensureBehaviors()">
        <td><a href="yii-base-component.html#ensureBehaviors()-detail">ensureBehaviors()</a></td>
        <td>Makes sure that the behaviors declared in <a href="yii-base-component.html#behaviors()-detail">behaviors()</a> are attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr id="exportFixtures()">
        <td><a href="yii-faker-fixturecontroller.html#exportFixtures()-detail">exportFixtures()</a></td>
        <td>Returns exported to the string representation of given fixtures array.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="findLayoutFile()">
        <td><a href="yii-base-controller.html#findLayoutFile()-detail">findLayoutFile()</a></td>
        <td>Finds the applicable layout file.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="fixtures()">
        <td><a href="yii-test-fixturetrait.html#fixtures()-detail">fixtures()</a></td>
        <td>Declares the fixtures that are needed by the current test case.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr id="generateFixture()">
        <td><a href="yii-faker-fixturecontroller.html#generateFixture()-detail">generateFixture()</a></td>
        <td>Generates fixture from given template</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr id="generateFixtureFile()">
        <td><a href="yii-faker-fixturecontroller.html#generateFixtureFile()-detail">generateFixtureFile()</a></td>
        <td>Generates fixture file by the given fixture template file.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="getActionArgsHelp()">
        <td><a href="yii-console-controller.html#getActionArgsHelp()-detail">getActionArgsHelp()</a></td>
        <td>Returns the help information for the anonymous arguments for the action.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getActionHelp()">
        <td><a href="yii-console-controller.html#getActionHelp()-detail">getActionHelp()</a></td>
        <td>Returns the detailed help information for the specified action.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getActionHelpSummary()">
        <td><a href="yii-console-controller.html#getActionHelpSummary()-detail">getActionHelpSummary()</a></td>
        <td>Returns a one-line short summary describing the specified action.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
                <tr class="inherited" id="getActionOptionsHelp()">
        <td><a href="yii-console-controller.html#getActionOptionsHelp()-detail">getActionOptionsHelp()</a></td>
        <td>Returns the help information for the options for the action.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getBehavior()">
        <td><a href="yii-base-component.html#getBehavior()-detail">getBehavior()</a></td>
        <td>Returns the named behavior object.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getBehaviors()">
        <td><a href="yii-base-component.html#getBehaviors()-detail">getBehaviors()</a></td>
        <td>Returns all behaviors attached to this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="getFixture()">
        <td><a href="yii-test-fixturetrait.html#getFixture()-detail">getFixture()</a></td>
        <td>Returns the named fixture.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr class="inherited" id="getFixtures()">
        <td><a href="yii-test-fixturetrait.html#getFixtures()-detail">getFixtures()</a></td>
        <td>Returns the fixture objects as specified in <a href="yii-test-fixturetrait.html#globalFixtures()-detail">globalFixtures()</a> and <a href="yii-test-fixturetrait.html#fixtures()-detail">fixtures()</a>.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr id="getGenerator()">
        <td><a href="yii-faker-fixturecontroller.html#getGenerator()-detail">getGenerator()</a></td>
        <td>Returns Faker generator instance. Getter for private property.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="getHelp()">
        <td><a href="yii-console-controller.html#getHelp()-detail">getHelp()</a></td>
        <td>Returns help information for this controller.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getHelpSummary()">
        <td><a href="yii-console-controller.html#getHelpSummary()-detail">getHelpSummary()</a></td>
        <td>Returns one-line short summary describing this controller.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getModules()">
        <td><a href="yii-base-controller.html#getModules()-detail">getModules()</a></td>
        <td>Returns all ancestor modules of this controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="getOptionValues()">
        <td><a href="yii-console-controller.html#getOptionValues()-detail">getOptionValues()</a></td>
        <td>Returns properties corresponding to the options for the action id
Child classes may override this method to specify possible properties.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getPassedOptionValues()">
        <td><a href="yii-console-controller.html#getPassedOptionValues()-detail">getPassedOptionValues()</a></td>
        <td>Returns the properties corresponding to the passed options</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getPassedOptions()">
        <td><a href="yii-console-controller.html#getPassedOptions()-detail">getPassedOptions()</a></td>
        <td>Returns the names of valid options passed during execution.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="getRoute()">
        <td><a href="yii-base-controller.html#getRoute()-detail">getRoute()</a></td>
        <td>Returns the route of the current request.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="getUniqueId()">
        <td><a href="yii-base-controller.html#getUniqueId()-detail">getUniqueId()</a></td>
        <td>Returns the unique ID of the controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="getView()">
        <td><a href="yii-base-controller.html#getView()-detail">getView()</a></td>
        <td>Returns the view object that can be used to render views or view files.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="getViewPath()">
        <td><a href="yii-base-controller.html#getViewPath()-detail">getViewPath()</a></td>
        <td>Returns the directory containing view files for this controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="globalFixtures()">
        <td><a href="yii-test-fixturetrait.html#globalFixtures()-detail">globalFixtures()</a></td>
        <td>Declares the fixtures shared required by different test cases.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr class="inherited" id="hasEventHandlers()">
        <td><a href="yii-base-component.html#hasEventHandlers()-detail">hasEventHandlers()</a></td>
        <td>Returns a value indicating whether there is any handler attached to the named event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="hasMethod()">
        <td><a href="yii-base-object.html#hasMethod()-detail">hasMethod()</a></td>
        <td>Returns a value indicating whether a method is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="hasProperty()">
        <td><a href="yii-base-object.html#hasProperty()-detail">hasProperty()</a></td>
        <td>Returns a value indicating whether a property is defined.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="init()">
        <td><a href="yii-base-object.html#init()-detail">init()</a></td>
        <td>Initializes the object.</td>
        <td><a href="yii-base-object.html">yii\base\Object</a></td>
    </tr>
            <tr class="inherited" id="isColorEnabled()">
        <td><a href="yii-console-controller.html#isColorEnabled()-detail">isColorEnabled()</a></td>
        <td>Returns a value indicating whether ANSI color is enabled.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="loadFixtures()">
        <td><a href="yii-test-fixturetrait.html#loadFixtures()-detail">loadFixtures()</a></td>
        <td>Loads the specified fixtures.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
            <tr class="inherited" id="needToApplyAll()">
        <td><a href="yii-console-controllers-fixturecontroller.html#needToApplyAll()-detail">needToApplyAll()</a></td>
        <td>Checks if needed to apply all fixtures.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="notifyNothingToLoad()">
        <td><a href="yii-console-controllers-fixturecontroller.html#notifyNothingToLoad()-detail">notifyNothingToLoad()</a></td>
        <td>Notifies user that there are no fixtures to load according input conditions</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="notifyNothingToUnload()">
        <td><a href="yii-console-controllers-fixturecontroller.html#notifyNothingToUnload()-detail">notifyNothingToUnload()</a></td>
        <td>Notifies user that there are no fixtures to unload according input conditions</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr class="inherited" id="off()">
        <td><a href="yii-base-component.html#off()-detail">off()</a></td>
        <td>Detaches an existing event handler from this component.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="on()">
        <td><a href="yii-base-component.html#on()-detail">on()</a></td>
        <td>Attaches an event handler to an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="optionAliases()">
        <td><a href="yii-console-controllers-fixturecontroller.html#optionAliases()-detail">optionAliases()</a></td>
        <td>Returns option alias names.</td>
        <td><a href="yii-console-controllers-fixturecontroller.html">yii\console\controllers\FixtureController</a></td>
    </tr>
            <tr id="options()">
        <td><a href="yii-faker-fixturecontroller.html#options()-detail">options()</a></td>
        <td>Returns the names of valid options for the action (id)
An option requires the existence of a public member variable whose
name is the option name.</td>
        <td><a href="yii-faker-fixturecontroller.html">yii\faker\FixtureController</a></td>
    </tr>
                        <tr class="inherited" id="prompt()">
        <td><a href="yii-console-controller.html#prompt()-detail">prompt()</a></td>
        <td>Prompts the user for input and validates it</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="render()">
        <td><a href="yii-base-controller.html#render()-detail">render()</a></td>
        <td>Renders a view and applies layout if available.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="renderContent()">
        <td><a href="yii-base-controller.html#renderContent()-detail">renderContent()</a></td>
        <td>Renders a static string by applying a layout.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="renderFile()">
        <td><a href="yii-base-controller.html#renderFile()-detail">renderFile()</a></td>
        <td>Renders a view file.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="renderPartial()">
        <td><a href="yii-base-controller.html#renderPartial()-detail">renderPartial()</a></td>
        <td>Renders a view without applying layout.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="run()">
        <td><a href="yii-base-controller.html#run()-detail">run()</a></td>
        <td>Runs a request specified in terms of a route.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="runAction()">
        <td><a href="yii-console-controller.html#runAction()-detail">runAction()</a></td>
        <td>Runs an action with the specified action ID and parameters.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="select()">
        <td><a href="yii-console-controller.html#select()-detail">select()</a></td>
        <td>Gives the user an option to choose from. Giving '?' as an input will show
a list of options to choose from and their explanations.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="setView()">
        <td><a href="yii-base-controller.html#setView()-detail">setView()</a></td>
        <td>Sets the view object to be used by this controller.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="setViewPath()">
        <td><a href="yii-base-controller.html#setViewPath()-detail">setViewPath()</a></td>
        <td>Sets the directory that contains the view files.</td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
            <tr class="inherited" id="stderr()">
        <td><a href="yii-console-controller.html#stderr()-detail">stderr()</a></td>
        <td>Prints a string to STDERR</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="stdout()">
        <td><a href="yii-console-controller.html#stdout()-detail">stdout()</a></td>
        <td>Prints a string to STDOUT</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="trigger()">
        <td><a href="yii-base-component.html#trigger()-detail">trigger()</a></td>
        <td>Triggers an event.</td>
        <td><a href="yii-base-component.html">yii\base\Component</a></td>
    </tr>
            <tr class="inherited" id="unloadFixtures()">
        <td><a href="yii-test-fixturetrait.html#unloadFixtures()-detail">unloadFixtures()</a></td>
        <td>Unloads the specified fixtures.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
    </table>
</div>

<div class="summary doc-method">
<h2>Protected Methods</h2>

<p><a href="#" class="toggle">Hide inherited methods</a></p>

<table class="summary-table table table-striped table-bordered table-hover">
<colgroup>
    <col class="col-method" />
    <col class="col-description" />
    <col class="col-defined" />
</colgroup>
<tr>
  <th>Method</th><th>Description</th><th>Defined By</th>
</tr>
                                                                                                                        <tr class="inherited" id="createFixtures()">
        <td><a href="yii-test-fixturetrait.html#createFixtures()-detail">createFixtures()</a></td>
        <td>Creates the specified fixture instances.</td>
        <td><a href="yii-test-fixturetrait.html">yii\test\FixtureTrait</a></td>
    </tr>
                                                        <tr class="inherited" id="getActionMethodReflection()">
        <td><a href="yii-console-controller.html#getActionMethodReflection()-detail">getActionMethodReflection()</a></td>
        <td></td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
                                                                                                                                    <tr class="inherited" id="parseDocCommentDetail()">
        <td><a href="yii-console-controller.html#parseDocCommentDetail()-detail">parseDocCommentDetail()</a></td>
        <td>Returns full description from the docblock.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="parseDocCommentSummary()">
        <td><a href="yii-console-controller.html#parseDocCommentSummary()-detail">parseDocCommentSummary()</a></td>
        <td>Returns the first line of docblock.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
            <tr class="inherited" id="parseDocCommentTags()">
        <td><a href="yii-console-controller.html#parseDocCommentTags()-detail">parseDocCommentTags()</a></td>
        <td>Parses the comment block into tags.</td>
        <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
    </tr>
                                                            </table>
</div>

<a id="events"></a>
<div class="summary doc-event">
    <h2>Events</h2>

    <p><a href="#" class="toggle">Hide inherited events</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-event" />
        <col class="col-type" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Event</th><th>Type</th><th>Description</th><th>Defined By</th>
    </tr>
        <tr class="inherited" id="EVENT_AFTER_ACTION">
        <td><a href="yii-base-controller.html#EVENT_AFTER_ACTION-detail">EVENT_AFTER_ACTION</a></td>
        <td><a href="yii-base-actionevent.html">yii\base\ActionEvent</a></td>
        <td>
            An event raised right after executing a controller action.                    </td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
        <tr class="inherited" id="EVENT_BEFORE_ACTION">
        <td><a href="yii-base-controller.html#EVENT_BEFORE_ACTION-detail">EVENT_BEFORE_ACTION</a></td>
        <td><a href="yii-base-actionevent.html">yii\base\ActionEvent</a></td>
        <td>
            An event raised right before executing a controller action.                    </td>
        <td><a href="yii-base-controller.html">yii\base\Controller</a></td>
    </tr>
        </table>
</div>

<a id="constants"></a>
<div class="summary doc-const">
    <h2>Constants</h2>

    <p><a href="#" class="toggle">Hide inherited constants</a></p>

    <table class="summary-table table table-striped table-bordered table-hover">
    <colgroup>
        <col class="col-const" />
        <col class="col-value" />
        <col class="col-description" />
        <col class="col-defined" />
    </colgroup>
    <tr>
        <th>Constant</th><th>Value</th><th>Description</th><th>Defined By</th>
    </tr>
            <tr class="inherited" id="EXIT_CODE_ERROR">
          <td id="EXIT_CODE_ERROR-detail">EXIT_CODE_ERROR</td>
          <td>1</td>
          <td>
</td>
          <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
        </tr>
            <tr class="inherited" id="EXIT_CODE_NORMAL">
          <td id="EXIT_CODE_NORMAL-detail">EXIT_CODE_NORMAL</td>
          <td>0</td>
          <td>
</td>
          <td><a href="yii-console-controller.html">yii\console\Controller</a></td>
        </tr>
        </table>
</div>

<h2>Property Details</h2>

<div class="property-doc">

    <div class="detail-header h3" id="$count-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$count-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L156" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L156" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $count        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Total count of data per fixture. Defaults to 2.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.integer">integer</a></span> <a href="yii-faker-fixturecontroller.html#$count-detail">$count</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">2</span></div>


    <div class="detail-header h3" id="$fixtureDataPath-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$fixtureDataPath-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L148" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L148" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $fixtureDataPath        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Alias to the fixture data path, where data files should be written.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-faker-fixturecontroller.html#$fixtureDataPath-detail">$fixtureDataPath</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'@tests/unit/fixtures/data'</span></div>


    <div class="detail-header h3" id="$generator-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$generator-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $generator        <span class="detail-header-tag small">
            public                         <em>read-only</em>                         property
                    </span>
    </div>

    <div class="doc-description">
        
            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type">\Faker\Generator</span> <strong><a href="yii-faker-fixturecontroller.html#getGenerator()-detail">getGenerator</a></strong> ( )</div>


    <div class="detail-header h3" id="$language-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$language-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L152" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L152" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $language        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Language to use when generating fixtures data.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-faker-fixturecontroller.html#$language-detail">$language</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">null</span></div>


    <div class="detail-header h3" id="$providers-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$providers-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L161" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L161" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $providers        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Additional data providers that can be created by user and will be added to the Faker generator.
More info in <a href="https://github.com/fzaninotto/Faker.">Faker</a> library docs.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <a href="yii-faker-fixturecontroller.html#$providers-detail">$providers</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;[]</span></div>


    <div class="detail-header h3" id="$templatePath-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#$templatePath-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L144" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L144" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        $templatePath        <span class="detail-header-tag small">
            public                                                property
                    </span>
    </div>

    <div class="doc-description">
        <p>Alias to the template path, where all tables templates are stored.</p>

            </div>

    <div class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <a href="yii-faker-fixturecontroller.html#$templatePath-detail">$templatePath</a> <span style="color: #0000BB"></span><span style="color: #007700">=&nbsp;</span><span style="color: #DD0000">'@tests/unit/templates/fixtures'</span></div>

</div>
<h2>Method Details</h2>

<div class="method-doc">

    <div class="detail-header h3" id="actionGenerate()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#actionGenerate()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L222" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L222" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        actionGenerate()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates fixtures and fill them with Faker data.</strong></p>

        <p>For example,</p>
<pre><code class="hljs dockerfile">//generate fixtures in russian language
yii fixture/generate <span class="hljs-built_ins">user</span> --count=5 --language=ru_RU

//generate several fixtures
yii fixture/generate <span class="hljs-built_ins">user</span> profile team
</code></pre>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#actionGenerate()-detail">actionGenerate</a></strong> ( )</td></tr>
                                                            <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-base-invalidparamexception.html">yii\base\InvalidParamException</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                            <tr>
                  <th class="param-name-col">throws</th>
                  <td class="param-type-col"><a href="yii-console-exception.html">yii\console\Exception</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                        </table>

<!--	-->

    <div class="detail-header h3" id="actionGenerateAll()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#actionGenerateAll()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L265" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L265" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        actionGenerateAll()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates all fixtures template path that can be found.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#actionGenerateAll()-detail">actionGenerateAll</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="actionTemplates()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#actionTemplates()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L196" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L196" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        actionTemplates()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Lists all available fixtures template files.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#actionTemplates()-detail">actionTemplates</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="addProviders()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#addProviders()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L403" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L403" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        addProviders()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Adds users providers to the faker generator.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#addProviders()-detail">addProviders</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="beforeAction()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#beforeAction()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L182" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L182" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        beforeAction()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>This method is invoked right before an action is executed.</strong></p>

        <p>The method will trigger the <a href="yii-base-controller.html#EVENT_BEFORE_ACTION-detail">EVENT_BEFORE_ACTION</a> event. The return value of the method
will determine whether the action should continue to run.</p>
<p>In case the action should not run, the request should be handled inside of the <code>beforeAction</code> code
by either providing the necessary output or redirecting the request. Otherwise the response will be empty.</p>
<p>If you override this method, your code should look like the following:</p>
<pre><code class="hljs php language-php"><span class="hljs-keyword">public</span> <span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">beforeAction</span><span class="hljs-params">(<span class="hljs-variable">$action</span>)</span>
</span>{
    <span class="hljs-comment">// your custom code here, if you want the code to run before action filters,</span>
    <span class="hljs-comment">// which are triggered on the [[EVENT_BEFORE_ACTION]] event, e.g. PageCache or AccessControl</span>

    <span class="hljs-keyword">if</span> (!<span class="hljs-keyword">parent</span>::beforeAction(<span class="hljs-variable">$action</span>)) {
        <span class="hljs-keyword">return</span> <span class="hljs-keyword">false</span>;
    }

    <span class="hljs-comment">// other custom code here</span>

    <span class="hljs-keyword">return</span> <span class="hljs-keyword">true</span>; <span class="hljs-comment">// or false to not run the action</span>
}
</code></pre>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yii-faker-fixturecontroller.html#beforeAction()-detail">beforeAction</a></strong> ( <span style="color: #0000BB">$action</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$action</span></td>
                  <td class="param-type-col"><a href="yii-base-action.html">yii\base\Action</a></td>
                  <td class="param-desc-col"><p>The action to be executed.</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.boolean">boolean</a></td>
                  <td class="param-desc-col"><p>Whether the action should continue to run.</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="checkPaths()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#checkPaths()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L391" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L391" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        checkPaths()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Check if the template path and migrations path exists and writable.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#checkPaths()-detail">checkPaths</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="confirmGeneration()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#confirmGeneration()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L457" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L457" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        confirmGeneration()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Prompts user with message if he confirm generation with given fixture templates files.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.boolean">boolean</a></span> <strong><a href="yii-faker-fixturecontroller.html#confirmGeneration()-detail">confirmGeneration</a></strong> ( <span style="color: #0000BB">$files</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$files</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="exportFixtures()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#exportFixtures()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L415" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L415" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        exportFixtures()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns exported to the string representation of given fixtures array.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.string">string</a></span> <strong><a href="yii-faker-fixturecontroller.html#exportFixtures()-detail">exportFixtures</a></strong> ( <span style="color: #0000BB">$fixtures</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$fixtures</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"></td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Exported fixtures format</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="generateFixture()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#generateFixture()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L426" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L426" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateFixture()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates fixture from given template</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-faker-fixturecontroller.html#generateFixture()-detail">generateFixture</a></strong> ( <span style="color: #0000BB">$_template_</span>, <span style="color: #0000BB">$index</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$_template_</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The fixture template file</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$index</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.integer">integer</a></td>
                  <td class="param-desc-col"><p>The current fixture index</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>Fixture</p>
</td>
                </tr>
                                    </table>

<!--	-->

    <div class="detail-header h3" id="generateFixtureFile()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#generateFixtureFile()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L439" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L439" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        generateFixtureFile()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Generates fixture file by the given fixture template file.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">void</span> <strong><a href="yii-faker-fixturecontroller.html#generateFixtureFile()-detail">generateFixtureFile</a></strong> ( <span style="color: #0000BB">$templateName</span>, <span style="color: #0000BB">$templatePath</span>, <span style="color: #0000BB">$fixtureDataPath</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$templateName</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Template file name</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$templatePath</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Path where templates are stored</p>
</td>
                </tr>
                            <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$fixtureDataPath</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>Fixture data path where generated file should be written</p>
</td>
                </tr>
                                                </table>

<!--	-->

    <div class="detail-header h3" id="getGenerator()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#getGenerator()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L379" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L379" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        getGenerator()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns Faker generator instance. Getter for private property.</strong></p>

        
            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type">\Faker\Generator</span> <strong><a href="yii-faker-fixturecontroller.html#getGenerator()-detail">getGenerator</a></strong> ( )</td></tr>
            </table>

<!--	-->

    <div class="detail-header h3" id="options()-detail">
        <a href="#" class="tool-link" title="go to top"><span class="glyphicon glyphicon-arrow-up"></span></a>
        <a class="tool-link hash" href="yii-faker-fixturecontroller.html#options()-detail" title="direct link to this method"><span class="glyphicon icon-hash"></span></a>
                    <a href="https://github.com/yiisoft/yii2-faker/edit/master/FixtureController.php#L172" class="tool-link" title="edit on github"><span class="glyphicon glyphicon-pencil"></span></a>
            <a href="https://github.com/yiisoft/yii2-faker/blob/master/FixtureController.php#L172" class="tool-link" title="view source on github"><span class="glyphicon glyphicon-eye-open"></span></a>
        
        options()
        <span class="detail-header-tag small">
            public                                    method
                    </span>
    </div>

    <div class="doc-description">
        <p><strong>Returns the names of valid options for the action (id)
An option requires the existence of a public member variable whose
name is the option name.</strong></p>

        <p>Child classes may override this method to specify possible options.</p>
<p>Note that the values setting via options are not available
until <a href="yii-faker-fixturecontroller.html#beforeAction()-detail">beforeAction()</a> is being called.</p>

            </div>

    <table class="detail-table table table-striped table-bordered table-hover">
        <tr><td colspan="3" class="signature"><span class="signature-defs">public</span> <span class="signature-type"><a href="http://www.php.net/language.types.array">array</a></span> <strong><a href="yii-faker-fixturecontroller.html#options()-detail">options</a></strong> ( <span style="color: #0000BB">$actionID</span> )</td></tr>
                                    <tr>
                  <td class="param-name-col"><span style="color: #0000BB">$actionID</span></td>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.string">string</a></td>
                  <td class="param-desc-col"><p>The action id of the current request</p>
</td>
                </tr>
                                        <tr>
                  <th class="param-name-col">return</th>
                  <td class="param-type-col"><a href="http://www.php.net/language.types.array">array</a></td>
                  <td class="param-desc-col"><p>The names of the options valid for the action</p>
</td>
                </tr>
                                    </table>

<!--	-->
</div>
        </div>
</div>

<script type="text/javascript">
    /*<![CDATA[*/
    $("a.toggle").on('click', function () {
        var $this = $(this);
        if ($this.hasClass('properties-hidden')) {
            $this.text($this.text().replace(/Show/,'Hide'));
            $this.parents(".summary").find(".inherited").show();
            $this.removeClass('properties-hidden');
        } else {
            $this.text($this.text().replace(/Hide/,'Show'));
            $this.parents(".summary").find(".inherited").hide();
            $this.addClass('properties-hidden');
        }

        return false;
    });
    /*
     $(".sourceCode a.show").toggle(function () {
     $(this).text($(this).text().replace(/show/,'hide'));
     $(this).parents(".sourceCode").find("div.code").show();
     },function () {
     $(this).text($(this).text().replace(/hide/,'show'));
     $(this).parents(".sourceCode").find("div.code").hide();
     });
     $("a.sourceLink").click(function () {
     $(this).attr('target','_blank');
     });
     */
    /*]]>*/
</script>


</div>

<footer class="footer">
        <p class="pull-right"><small>Page generated on Sat, 09 Jul 2016 12:15:54 +0000</small></p>
    Powered by <a href="http://www.yiiframework.com/" rel="external">Yii Framework</a></footer>

<script type="text/javascript">jQuery(document).ready(function () {
    var shiftWindow = function () { scrollBy(0, -50) };
    if (location.hash) setTimeout(shiftWindow, 1);
    window.addEventListener("hashchange", shiftWindow);
var element = document.createElement("script");
element.src = "./jssearch.index.js";
document.body.appendChild(element);

var searchBox = $('#searchbox');

// search when typing in search field
searchBox.on("keyup", function(event) {
    var query = $(this).val();

    if (query == '' || event.which == 27) {
        $('#search-resultbox').hide();
        return;
    } else if (event.which == 13) {
        var selectedLink = $('#search-resultbox a.selected');
        if (selectedLink.length != 0) {
            document.location = selectedLink.attr('href');
            return;
        }
    } else if (event.which == 38 || event.which == 40) {
        $('#search-resultbox').show();

        var selected = $('#search-resultbox a.selected');
        if (selected.length == 0) {
            $('#search-results').find('a').first().addClass('selected');
        } else {
            var next;
            if (event.which == 40) {
                next = selected.parent().next().find('a').first();
            } else {
                next = selected.parent().prev().find('a').first();
            }
            if (next.length != 0) {
                var resultbox = $('#search-results');
                var position = next.position();

//              TODO scrolling is buggy and jumps around
//                resultbox.scrollTop(Math.floor(position.top));
//                console.log(position.top);

                selected.removeClass('selected');
                next.addClass('selected');
            }
        }

        return;
    }
    $('#search-resultbox').show();
    $('#search-results').html('<li><span class="no-results">No results</span></li>');

    var result = jssearch.search(query);

    if (result.length > 0) {
        var i = 0;
        var resHtml = '';

        for (var key in result) {
            if (i++ > 20) {
                break;
            }
            resHtml = resHtml +
            '<li><a href="' + result[key].file.u.substr(3) +'"><span class="title">' + result[key].file.t + '</span>' +
            '<span class="description">' + result[key].file.d + '</span></a></li>';
        }
        $('#search-results').html(resHtml);
    }
});

// hide the search results on ESC
$(document).on("keyup", function(event) { if (event.which == 27) { $('#search-resultbox').hide(); } });
// hide search results on click to document
$(document).bind('click', function (e) { $('#search-resultbox').hide(); });
// except the following:
searchBox.bind('click', function(e) { e.stopPropagation(); });
$('#search-resultbox').bind('click', function(e) { e.stopPropagation(); });

});</script></body>
</html>
